时效性|事实_SSO轻量级实现指南（原生Java实现）：SSOServer部分

篇首语：本文由编程笔记#小编为大家整理，主要介绍了SSO 轻量级实现指南（原生 Java 实现）：SSO Server 部分相关的知识，希望对你有一定的参考价值。

OAuth 是当前单点登录&＃xff08;SSO&＃xff09;和用户授权的标准协议——现在就让我们一起动手撸一个 SSO 的实现吧&＃xff01;

源码在&＃xff1a;

• SSO 中心 https://gitee.com/sp42_admin/ajaxjs/tree/master/aj-sso
• SSO Client 客户端 https://gitee.com/sp42_admin/ajaxjs/tree/master/aj-sso-client

我们开源的特色&＃xff1a;

• 轻量级&＃xff0c;代码行数少
• 除了 JVM 和 Spring 没啥依赖&＃xff0c;尽量原生&＃xff0c;基本没什么第三方引用库
• 代码风格务求清晰、简洁易维护、干净

SSO Server 即 SSO 中心&＃xff0c;负责统一用户认证的。另外有 SSO Client 部分&＃xff0c;我们另起文章再讲。

开始之前先说说废话&＃xff08;之所以说废话的原因是&＃xff0c;其实你可以无视这段概念性的介绍&＃xff0c;直接开撸&＃xff09;。

OAuth 是 OAuth&＃xff0c;OAuth 不单单为 SSO 服务的。OAuth 协议初衷是为了用户不用告诉第三方系统账号和密码就可以访问受限的资源&＃xff0c;——可以成为 SSO 的通行协议这个想必原设计者都没有料到的。没有 OAuth 之前&＃xff0c;SSO 老早就有&＃xff0c;只是各家各法自行实现&＃xff0c;总能达到单点登录的目的。也就是说&＃xff0c;SSO 的协议不一定是 OAuth&＃xff0c;而 OAuth 不一定服务于 SSO。

SSO 与 OAuth 都是紧扣“我是谁”之要义&＃xff0c;即用户身份认证的问题&＃xff0c;这也是核心的问题&＃xff0c;所有关于用户一切的信息都应由 SSO 中心或 OAuth 资源服务器所把控。稍有出入的是 OAuth 认证服务器往往是与资源服务器在一起的&＃xff0c;这个一起的意思可以是物理意义上的同一部机器。但 SSO 中心呢&＃xff1f;一般简单、纯粹的得多&＃xff0c;就是做用户认证的&＃xff0c;——即使涉及用户权限的 SSO 中心&＃xff0c;顶多也是功能性的、系统级的权限控制&＃xff0c;而不是垂直的数据权限控制&＃xff08;资源的权限控制&＃xff09;。也就是说&＃xff0c;SSO 中心不负责资源问题&＃xff0c;而资源往往在客户端 Client 那边。总之&＃xff0c;狭义的 OAuth 很可能是整个大系统中&＃xff0c;对外服务的一个模块&＃xff1b;而 SSO 中心则纯粹得多&＃xff0c;通常独立部署&＃xff0c;独立服务&＃xff0c;只做好 SSO 一件事情。

在流程上&＃xff0c;SSO 与 OAuth 也有显著不同&＃xff0c;例如同意授权访问&＃xff0c;典型的第三方登录是有这一步的&＃xff08;如下图所示&＃xff09;&＃xff0c;但 SSO 没有吧&＃xff1f;

SS&＃xff2f; 流程如下&＃xff08;借图&＃xff0c;来自这里&＃xff09;

登录 Login

当前是使用账号密码登录&＃xff0c;未来也应该支持如微信、微博的第三方登录。登录的作于在于识别“我是谁”的目的&＃xff0c;在 SSO 中心标识某某用户已经是在登录的状态&＃xff0c;以实现“单点登录”。具体说&＃xff0c;会产生关键的标识状态 Session 和浏览器 COOKIEs。Session 仍是记忆登录状态的重要信息&＃xff0c;否则后面获取 Token 就无法进行&＃xff08;因为不知道哪个用户&＃xff01;&＃xff09;。

登录控制器 LoginController 源码在这里&＃xff0c;关键的 Service 部分在这里。

登录成功或失败一般允许指 redirectUrl&＃xff0c;但我们没有&＃xff0c;因为当前这登录接口是跨域的&＃xff0c;界面完全由客户端指定&＃xff0c;所以客户端自己控制就好。不过感觉上登录界面放在 SSO 中心会安全一点吧&＃xff0c;毕竟允许跨域了。

注销

当前注销只是清空 session 而已&＃xff0c;但实际 SSO 复杂得多&＃xff0c;理论上某个应用注销了&＃xff0c;其他所有已登录的应用也有要同步注销。这部分暂且不表&＃xff0c;待后面补充。

注册分为用户注册和客户端注册。

用户注册

用户注册没什么好说的&＃xff0c;常规流程的逻辑&＃xff0c;参见源码。

客户端注册

接入的客户端有时也称“应用”。客户端模型如下面 SQL 所示。clientId 有时也称 appId 或 appKey。clientSecret 是密钥&＃xff0c;但跟密码的意思没什么区别&＃xff0c;肯定不能外泄出去。

CREATE TABLE &＃96;auth_client_details&＃96; (
&＃96;id&＃96; INT(11) NOT NULL AUTO_INCREMENT COMMENT &＃39;主键 id&＃xff0c;自增&＃39;,
&＃96;name&＃96; VARCHAR(20) NOT NULL COMMENT &＃39;客户端名称&＃39; COLLATE &＃39;utf8mb4_bin&＃39;,
&＃96;content&＃96; VARCHAR(256) NULL DEFAULT NULL COMMENT &＃39;简介&＃39; COLLATE &＃39;utf8mb4_bin&＃39;,
&＃96;clientId&＃96; VARCHAR(100) NOT NULL COMMENT &＃39;接入的客户端ID&＃39; COLLATE &＃39;utf8mb4_bin&＃39;,
&＃96;clientSecret&＃96; VARCHAR(255) NOT NULL COMMENT &＃39;接入的客户端的密钥&＃39; COLLATE &＃39;utf8mb4_bin&＃39;,
&＃96;redirecUri&＃96; VARCHAR(1000) NULL DEFAULT NULL COMMENT &＃39;回调地址&＃39; COLLATE &＃39;utf8mb4_bin&＃39;,
&＃96;stat&＃96; TINYINT(4) NULL DEFAULT NULL COMMENT &＃39;数据字典&＃xff1a;状态&＃39;,
&＃96;uid&＃96; BIGINT(20) NULL DEFAULT NULL COMMENT &＃39;唯一 id&＃xff0c;通过 uuid 生成不重复 id&＃39;,
&＃96;extend&＃96; TEXT NULL DEFAULT NULL COMMENT &＃39;扩展 JSON 字段&＃39; COLLATE &＃39;utf8mb4_bin&＃39;,
&＃96;tenantId&＃96; INT(11) NULL DEFAULT NULL COMMENT &＃39;租户 id&＃39;,
&＃96;creator&＃96; INT(11) NULL DEFAULT NULL COMMENT &＃39;创建者 id&＃39;,
&＃96;createDate&＃96; DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT &＃39;也是注册时间&＃39;,
&＃96;updateDate&＃96; DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT &＃39;修改时间&＃39;,
PRIMARY KEY (&＃96;id&＃96;) USING BTREE
)
COMMENT&＃61;&＃39;接入的客户端信息表&＃39;
COLLATE&＃61;&＃39;utf8mb4_bin&＃39;


clientId 和 clientSecret 都是随机字符串生成的&＃xff0c;详见下面创建 client_details 部分。

&＃64;RestController
&＃64;RequestMapping("/oauth")
public class OauthController implements SsoDAO
/**
* 注册需要接入的客户端信息
*
* &＃64;param client
* &＃64;return
*/
&＃64;PostMapping(value &＃61; "/clientRegister", produces &＃61; MediaType.APPLICATION_JSON_VALUE)
public String clientRegister(&＃64;RequestParam ClientDetails client)
if (!StringUtils.hasText(client.getName()))
throw new IllegalArgumentException("客户端的名称和回调地址不能为空");
String clientId &＃61; StrUtil.getRandomString(24);// 生成24位随机的 clientId
ClientDetails savedClientDetails &＃61; findClientDetailsByClientId(clientId);
// 生成的 clientId 必须是唯一的&＃xff0c;尝试十次避免有重复的 clientId
for (int i &＃61; 0; i < 10; i&＃43;&＃43;)
if (savedClientDetails &＃61;&＃61; null)
break;
else
clientId &＃61; StrUtil.getRandomString(24);
savedClientDetails &＃61; findClientDetailsByClientId(clientId);


client.setClientId(clientId);
client.setClientSecret(StrUtil.getRandomString(32));
// 保存到数据库
return ClientDetailDAO.create(client) &＃61;&＃61; null ? BaseController.jsonNoOk() : BaseController.jsonOk();

……


SSO 登录

你以为上面用户登录就完事了&＃xff1f;只是完成了三分之一&＃xff0c;完整的单点登录还有其余的 66.6666……% ——我们接着看。

获取授权码

为什么要获取授权码&＃xff08;Authorization Code&＃xff09;&＃xff0c;不能直接返回 Token 吗&＃xff1f;因水平所限我也不太清楚&＃xff0c;好像为了安全性吧&＃xff0c;好像 OAuth 有其他模式不用授权码的&＃xff1f;我没去管了&＃xff0c;反正最主流就是授权码模式。不懂得看官请琢磨上面的流程图&＃xff0c;或者先去消化 OAuth 的机制。

获取授权码接口所需的参数参见 SsoController 控制器的方法&＃xff0c;源码这里。

&＃64;Autowired
private AuthorizationService authService;
/**
* 获取 Authorization Code
*
* &＃64;param client_id 客户端 ID
* &＃64;param redirect_uri 回调 URL
* &＃64;param scope 权限范围
* &＃64;param status 用于防止CSRF攻击&＃xff08;非必填&＃xff09;
* &＃64;param req 请求对象
* &＃64;return
*/
&＃64;RequestMapping(value &＃61; "/authorize_code", produces &＃61; BaseController.JSON)
public Object authorize(&＃64;RequestParam(required &＃61; true) String client_id,
// &＃64;formatter:off
&＃64;RequestParam(required &＃61; true) String redirect_uri,
&＃64;RequestParam(required &＃61; false) String scope,
&＃64;RequestParam(required &＃61; false) String status,
HttpServletRequest req)
// &＃64;formatter:on
LOGGER.info("获取 Authorization Code");
User loginedUser &＃61; null;
try
loginedUser &＃61; UserUtils.getLoginedUser(req);
catch (Throwable e)
LOGGER.warning(e);
return SsoUtil.oauthError(ErrorCodeEnum.INVALID_CLIENT);

// 生成 Authorization Code
String authorizationCode &＃61; authService.createAuthorizationCode(client_id, scope, loginedUser);
String params &＃61; "?code&＃61;" &＃43; authorizationCode;
if (StringUtils.hasText(status))
params &＃43;&＃61; "&status&＃61;" &＃43; status;
return new ModelAndView("redirect:" &＃43; redirect_uri &＃43; params);



据此我们了解几个事实。

• 只有用户登录了&＃xff0c;才有对应的授权码。UserUtils.getLoginedUser(req); 这句从 Session 返回已登录的用户信息。
• 用户哪个浏览器登录&＃xff0c;就在哪个浏览器获取授权码&＃xff0c;不然就是未登录状态。
• 该接口只能前端调用
• 该接口返回 HTTP 304 重定向&＃xff0c;携带 code 参数&＃xff08;就是授权码&＃xff09;跳转到 redirect_uri。就是说该接口不会返回什么 JSON。

状态码有时效性&＃xff0c;一般十分钟&＃xff0c;而且是一次性的&＃xff0c;用完了要销毁。

客户端接入 SSO 之第一步

从原理上讲&＃xff0c;这也是客户端服务接入 SSO 的第一步&＃xff08;当然我们会提供一个封装好的 SDK&＃xff0c;对于调用者是屏蔽细节的&＃xff09;。用户成功登录后&＃xff0c;已在 SSO 中心留存有 COOKIEs 的登录信息&＃xff0c;于是其他第三方应用可以访问 SSO 中心获取用户信息&＃xff08;当然不是直接获取&＃xff0c;而且先要获取授权码&＃xff09;。

客户端可以通过授权码获取 AccessToken&＃xff0c;然后再根据 AccessToken 获取用户信息&＃xff0c;完成本地登录。总之我们提到了两次登录验证&＃xff1a;第一次是用户身份验证&＃xff08;用户凭用户名和密码可以登录&＃xff09;&＃xff1b;第二次是客户端认证&＃xff08;客户端凭 id 和密钥再结合用户信息&＃xff08;授权码&＃xff09;去登录&＃xff09;&＃xff0c;这部分我们下面小结会详细讲。

生成授权码原理

进入 authService.createAuthorizationCode() 源码我们看看如何生成授权码。

/**
* 根据 clientId、scope 以及当前时间戳生成 AuthorizationCode&＃xff08;有效期为10分钟&＃xff09;
*
* &＃64;param clientId 客户端ID
* &＃64;param scope
* &＃64;param user 用户信息
* &＃64;return
*/
public String createAuthorizationCode(String clientId, String scope, User user)
if (!StringUtils.hasText(scope))
scope &＃61; "DEFAULT_SCOPE";
// 1. 拼装待加密字符串&＃xff08;clientId &＃43; scope &＃43; 当前精确到毫秒的时间戳&＃xff09;
String str &＃61; clientId &＃43; scope &＃43; String.valueOf(System.currentTimeMillis());
// 2. SHA1加密
String encryptedStr &＃61; Digest.getSHA1(str);
int timeout &＃61; ExpireEnum.AUTHORIZATION_CODE.getTime() * 60;
// 3.1 保存本次请求的授权范围
ExpireCache.CACHE.put(encryptedStr &＃43; ":scope", scope, timeout);
// 3.2 保存本次请求所属的用户信息
ExpireCache.CACHE.put(encryptedStr &＃43; ":user", user, timeout);
// 4. 返回Authorization Code
return encryptedStr;



主要是这么几步&＃xff1a;1. 拼装待加密字符串&＃xff08;clientId &＃43; scope &＃43; 当前精确到毫秒的时间戳&＃xff09;&＃xff1b;2. SHA1 加密&＃xff1b;3. 保存到缓存&＃xff08;不用保存在数据库&＃xff09;。

带过期时间的缓存大家想到的是 Redis&＃xff0c;但我这里用了 JVM 的缓存&＃xff0c;就是自己写的 Map&＃xff0c;无他&＃xff0c;懒得部署 Redis 了……

客户端认证&＃xff08;颁发 AccessToken&＃xff09;

客户端认证的过程就是颁发 AccessToken。我们看看客户端认证的源码定义&＃xff0c;需要哪些参数。

/**
* 通过 Authorization Code 获取 Access Token
*
* &＃64;param client_id 客户端 id
* &＃64;param client_secret 接入的客户端的密钥
* &＃64;param code 前面获取的 Authorization Code
* &＃64;param grant_type 授权方式
* &＃64;param request 请求对象
* &＃64;return
*/
&＃64;RequestMapping("/authorize")
public String issue(&＃64;RequestParam(required &＃61; true) String client_id,
// &＃64;formatter:off
&＃64;RequestParam(required &＃61; true) String client_secret,
&＃64;RequestParam(required &＃61; true) String code,
&＃64;RequestParam(required &＃61; true) String grant_type,
HttpServletRequest request)
// &＃64;formatter:on
LOGGER.info("通过 Authorization Code 获取 Access Token");
// 校验授权方式
if (!GrantTypeEnum.AUTHORIZATION_CODE.getType().equals(grant_type))
return SsoUtil.oauthError(ErrorCodeEnum.UNSUPPORTED_GRANT_TYPE);
ClientDetails savedClientDetails &＃61; findClientDetailsByClientId(client_id);
// 校验请求的客户端秘钥和已保存的秘钥是否匹配
if (!(savedClientDetails !&＃61; null && savedClientDetails.getClientSecret().equals(client_secret)))
return SsoUtil.oauthError(ErrorCodeEnum.INVALID_CLIENT);
String scope &＃61; ExpireCache.CACHE.get(code &＃43; ":scope", String.class);
User user &＃61; ExpireCache.CACHE.get(code &＃43; ":user", User.class);
// 如果能够通过 Authorization Code 获取到对应的用户信息&＃xff0c;则说明该 Authorization Code 有效
if (StringUtils.hasText(scope) && user !&＃61; null)
// 过期时间
Long expiresIn &＃61; LocalDateUtils.dayToSecond(ExpireEnum.ACCESS_TOKEN.getTime());
// 生成 Access Token
String accessTokenStr &＃61; authService.createAccessToken(user, savedClientDetails, grant_type, scope, expiresIn);
// 查询已经插入到数据库的 Access Token
AccessToken authAccessToken &＃61; AcessTokenDAO.setWhereQuery("accessToken", accessTokenStr).findOne();
// 生成 Refresh Token
String refreshTokenStr &＃61; authService.createRefreshToken(user, authAccessToken);
IssueToken token &＃61; new IssueToken(); // 返回数据
token.setAccess_token(authAccessToken.getAccessToken());
token.setRefresh_token(refreshTokenStr);
token.setExpires_in(expiresIn);
token.setScope(authAccessToken.getScope());
return JsonHelper.toJson(token);
else
return SsoUtil.oauthError(ErrorCodeEnum.INVALID_GRANT);



据此我们了解几个事实。

• 该接口只能服务端调用。客户端密钥保存在服务端&＃xff0c;不应暴露给前端。故所以认证客户端务必在服务端完成&＃xff0c;即后台来通讯请求。
• 进入该接口&＃xff0c;要判断密钥是否正确
• 授权码相当于获取缓存中的 key&＃xff0c;value 就是用户信息
• client 和 user 没问题之后&＃xff0c;可以创建 AccessToken
• AccessToken 保存到数据库。如果已有则再更新。
• 还生成 RefreshToken&＃xff0c;这将会后面讲
• 这个 AccessToken 外表一堆字符串&＃xff0c;实际蕴含什么意思呢&＃xff1f;Token 不是密码但胜似密码&＃xff0c;他内部包含了不仅用户信息还有客户端的信息&＃xff0c;故 AccessToken &＃61; 用户&＃43;客户端&＃xff08;应用&＃xff09;的信息

至此就完成了登录了&＃xff0c;进度……100%。

至于生成 Token 原理大家可以进入 Service 相关代码浏览&＃xff0c;大致都是 SHA1 加密之类的&＃xff0c;这里不再赘述。

实际设计中有两点“最佳实践”分享给大家。

• 虽然有份“获取授权码”和“客户端认证”两个接口两个步骤&＃xff0c;但前端一次请求就可以搞定了&＃xff0c;这是在 SSO_Client 前端执行的。
• 单纯返回 AccessToken 之外&＃xff0c;最好还要返回用户的详细信息&＃xff0c;不然又要前端请求多次。当然标准的 OAuth 没要求返回用户信息。不过目前我还去实现……有时间就搞

刷新 AccessToken-----> RefreshToken

一般 Token 时效性。

• AccessToken&＃xff0c;三十天
• RefreshToken 365 日

当然&＃xff0c;根据你的场景调整。

逻辑大同小异&＃xff0c;我们直接贴代码。

/**
* 通过 Refresh Token 刷新 Access Token
*
* &＃64;param refresh_token
* &＃64;return
*/
&＃64;RequestMapping(value &＃61; "/refreshToken", produces &＃61; MediaType.APPLICATION_JSON_VALUE)
public String refreshToken(&＃64;RequestParam(required &＃61; true) String refresh_token)
LOGGER.info("通过 Refresh Token 刷新 Access Token");
RefreshToken authRefreshToken &＃61; RefreshTokenDAO.setWhereQuery("refreshToken", refresh_token).findOne();
if (authRefreshToken &＃61;&＃61; null)
return SsoUtil.oauthError(ErrorCodeEnum.INVALID_GRANT);
// 如果 Refresh Token 已经失效&＃xff0c;则需要重新生成
if (SsoUtil.checkIfExpire(authRefreshToken))
return SsoUtil.oauthError(ErrorCodeEnum.EXPIRED_TOKEN);
// 获取存储的 Access Token
AccessToken authAccessToken &＃61; AcessTokenDAO.findById(authRefreshToken.getTokenId());
// 获取对应的客户端信息
ClientDetails savedClientDetails &＃61; ClientDetailDAO.findById(authAccessToken.getClientId());
// 获取对应的用户信息
User user &＃61; UserCommonDAO.UserDAO.findById(authAccessToken.getUserId());
// 新的过期时间
Long expiresIn &＃61; LocalDateUtils.dayToSecond(ExpireEnum.ACCESS_TOKEN.getTime());
// 生成新的 Access Token
String newAccessTokenStr &＃61; authService.createAccessToken(user, savedClientDetails, authAccessToken.getGrantType(), authAccessToken.getScope(), expiresIn);
IssueToken token &＃61; new IssueToken(); // 返回数据
token.setAccess_token(newAccessTokenStr);
token.setRefresh_token(refresh_token);
token.setExpires_in(expiresIn);
token.setScope(authAccessToken.getScope());
return JsonHelper.toJson(token);



有些厂家不是这么 RefreshToken 的&＃xff0c;它是使用基本认证的方式验证客户端身份&＃xff0c;如 Authorization: Basic $Base64.encode(clientId&＃43;":"&＃43;clientSecret)。可见它只需要客户端信息&＃xff0c;不需要用户信息。

AccesToken 和 RefreshToken 怎么用呢&＃xff1f;这就要看我们 SSO Client 如何调用了&＃xff0c;——下篇文章再为大家介绍。

SSO 中心没有想象中的难&＃xff0c;当然还有其他周边的问题&＃xff0c;如安全性的问题&＃xff0c;或者用户权限那部分&＃xff0c;会越做越复杂的。不管怎么样只要方向路线正确&＃xff0c;那么干就是了&＃xff01;

推荐参考文章

• OAuth2.0协议入门 ——非常不错&＃xff0c;我也是参考其代码实现&＃xff0c;它教会了我许多&＃xff01;
• SSO 开源实现 Kisso
• 基于 OAuth 2 的 smart-sso
• XXL-SSO
• IAM&＃xff1a;MaxKey 国内开源IAM第一品牌
• 旧帖《新浪微博如何实现 SSO 的分析》
• 单点登录跨域iframe互相通信方案